Add function to generate log file that contains broken links #1046
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A list of all broken links for versions of docs still under Maintenance Support are generated in **brokenLinks.log**. To eliminate potentially redundant entries in the log, only `onBrokenLinks` is set to `warn`.
**brokenLinks.log** is for internal/local purposes, so we don't need to include it in the build files.
To reduce work in fixing broken links for versions that we no longer support, the script checks for broken link for versions of docs that are currently under Maintenance Support.
josh-wong
added a commit
that referenced
this pull request
May 14, 2025
* Create filter-broken-link-warnings.js * Make all broken links show warning A list of all broken links for versions of docs still under Maintenance Support are generated in **brokenLinks.log**. To eliminate potentially redundant entries in the log, only `onBrokenLinks` is set to `warn`. * Add `brokenLinks.log` **brokenLinks.log** is for internal/local purposes, so we don't need to include it in the build files. * Add broken-link log generator to `build` command * Show broken links for versions under Maintenance Support To reduce work in fixing broken links for versions that we no longer support, the script checks for broken link for versions of docs that are currently under Maintenance Support.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a function to generate a log file that contains broken links when building the docs site. This log file is for reference when building the docs site locally. Therefore, we should regularly check for broken links.
Important
Once all links in versions of docs that are under Maintenance Support have been fixed, we should consider changing
warntothrowso that we can catch broken links immediately, rather than needing to check on a regular basis.Specifications:
onBrokenLinkstowarncatches external links, Markdown links, and anchor links, according to Docusaurus' documentation.Related issues and/or PRs
N/A
Changes made
onBrokenMarkdownLinksandon AnchorLinksoptions toignoresinceonBrokenLinksis set towarnand catches those two types of broken links as well as external links.buildcommand in package.json.Checklist
Additional notes (optional)
N/A